//
// MudTools.OfficeInterop 项目的版权、商标、专利和其他相关权利均受相应法律法规的保护。使用本项目应遵守相关法律法规和许可证的要求。
//
// 本项目主要遵循 MIT 许可证和 Apache 许可证（版本 2.0）进行分发和使用。许可证位于源代码树根目录中的 LICENSE-MIT 和 LICENSE-APACHE 文件。
//
// 不得利用本项目从事危害国家安全、扰乱社会秩序、侵犯他人合法权益等法律法规禁止的活动！任何基于本项目二次开发而产生的一切法律纠纷和责任，我们不承担任何责任！

using System.Drawing;

namespace MudTools.OfficeInterop.Excel;


/// <summary>
/// Excel Borders 集合对象的二次封装接口
/// 提供对 Microsoft.Office.Interop.Excel.Borders 的安全访问和操作
/// </summary>
public interface IExcelBorders : IEnumerable<IExcelBorder>, IDisposable
{
    #region 基础属性
    /// <summary>
    /// 应用到全局。
    /// </summary>
    bool ApplyToAll { get; set; }

    /// <summary>
    /// 获取边框集合中的边框数量
    /// 对应 Borders.Count 属性
    /// </summary>
    int Count { get; }

    /// <summary>
    /// 获取或设置自定义边框集合
    /// 键为边框索引类型，值为单元格格式对象
    /// </summary>
    Dictionary<XlBordersIndex, IExcelCellFormat> CustomBorders { get; set; }

    /// <summary>
    /// 获取指定类型的边框对象
    /// </summary>
    /// <param name="borderType">边框类型</param>
    /// <returns>边框对象</returns>
    IExcelBorder? this[XlBordersIndex borderType] { get; }

    /// <summary>
    /// 获取边框集合所在的父对象
    /// 对应 Borders.Parent 属性
    /// </summary>
    object? Parent { get; }

    /// <summary>
    /// 获取边框集合所在的Application对象
    /// 对应 Borders.Application 属性
    /// </summary>
    IExcelApplication? Application { get; }

    /// <summary>
    /// 获取或设置边框线条样式
    /// </summary>
    XlLineStyle LineStyle { get; set; }

    /// <summary>
    /// 获取或设置边框粗细
    /// </summary>
    XlBorderWeight Weight { get; set; }

    /// <summary>
    /// 获取或设置边框颜色
    /// </summary>
    Color Color { get; set; }

    /// <summary>
    /// 获取或设置边框的颜色。
    /// 对应 Border.ColorIndex 属性
    /// </summary>
    XlColorIndex ColorIndex { get; set; }

    #endregion

    #region 查找和筛选

    /// <summary>
    /// 根据线条样式查找边框
    /// </summary>
    /// <param name="lineStyle">线条样式</param>
    /// <returns>匹配的边框数组</returns>
    IExcelBorder[] FindByLineStyle(int lineStyle);

    /// <summary>
    /// 根据颜色查找边框
    /// </summary>
    /// <param name="color">边框颜色</param>
    /// <returns>匹配的边框数组</returns>
    IExcelBorder[] FindByColor(int color);

    /// <summary>
    /// 根据粗细查找边框
    /// </summary>
    /// <param name="weight">边框粗细</param>
    /// <returns>匹配的边框数组</returns>
    IExcelBorder[] FindByWeight(XlBorderWeight weight);
    #endregion

    #region 格式设置

    /// <summary>
    /// 设置所有边框的线条样式
    /// </summary>
    /// <param name="lineStyle">线条样式</param>
    /// <param name="weight">边框粗细</param>
    void SetLineStyle(XlLineStyle lineStyle, XlBorderWeight weight = XlBorderWeight.xlHairline);

    /// <summary>
    /// 设置所有边框的颜色
    /// </summary>
    /// <param name="color">边框颜色</param>
    void SetColor(Color color);

    /// <summary>
    /// 设置所有边框的粗细
    /// </summary>
    /// <param name="weight">边框粗细</param>
    void SetWeight(XlBorderWeight weight);

    /// <summary>
    /// 统一所有边框的格式
    /// </summary>
    /// <param name="lineStyle">线条样式</param>
    /// <param name="color">边框颜色</param>
    /// <param name="weight">边框粗细</param>
    void UniformFormat(Color color, XlLineStyle lineStyle = XlLineStyle.xlLineStyleNone, XlBorderWeight weight = XlBorderWeight.xlThin);

    /// <summary>
    /// 复制边框格式
    /// </summary>
    /// <param name="sourceBorder">源边框</param>
    /// <param name="applyToAll">是否应用到所有边框</param>
    void CopyFormat(IExcelBorder sourceBorder, bool applyToAll = false);

    /// <summary>
    /// 应用预设边框样式
    /// </summary>
    /// <param name="presetStyle">预设样式类型</param>
    void ApplyPresetStyle(int presetStyle);

    #endregion

}
